shared-domain-ux

(0 reviews)

TMF-683 - Customer Interaction

==> TMF-683

This operation is to create the Customer Interaction Record

URL

https://[localhost]:[port]/shared-domain-ux/v1/{businessId}/partyInteraction

url Param

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico	Y

name	value	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y
content-Type	string	application/json	Y

Request

curl --location 'https://nonprod.esb.cloud.lla.com/test/shared-domain-ux/tmf-api/partyInteractionManagement/v4/PR/partyInteraction' \
--header 'client_id: xxxxxxxxx' \
--header 'client_secret: xxxxxxxxxxx' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "Customer redeemed coupon PROMO-1GB-LOYALTY",  //comment
    "direction": "inbound", //inbound or outbound
    "reason": "CPN009",    //couponId
    "status": "completed", //this is the interaction, not the cupon/redemption, opened, inProgress, completed
    "channel": [
        {
            "name": "SideCar"
        }
    ],
    "interactionDate": {
        "completedDateTime": "2026-07-13T08:00:00Z" //now()
    },
    "interactionItem": [
        {
            "id": "PROMO-2026-Q2",  //promotionId
            "resolution": "RED-123456", //redemptionId
            "item": {
                "id": "7871234567",
                "name": "MSISDN"
            }
        }
    ]
}'

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - The request was successfully processed and created customer Interaction Record.

{
   "id": "a1B5g000000XXXEAI" //recordId
}

Definitions

Each of the request parameters is detailed.

name	type	description	required
description	string	Human-readable description of the interaction.	Y
direction	string	Direction of the interaction: `inbound` or `outbound`.	Y
reason	string	Coupon identifier for the promotion redemption.	Y
status	string	Status of the interaction: `opened`, `inProgress`, `completed`.	Y
channel	array	List of channels involved in the interaction.	Y
channel[].name	string	Name of the source system / channel.	Y
interactionDate	object	Timestamp information for the interaction.	Y
interactionDate.completedDateTime	datetime	Date and time the interaction was completed (ISO 8601).	Y
interactionItem	array	List of items involved in the interaction.	Y
interactionItem[].id	string	Promotion identifier.	Y
interactionItem[].resolution	string	Redemption identifier.	Y
interactionItem[].item	object	Reference to the subscriber asset item.	Y
interactionItem[].item.id	string	MSISDN of the subscriber.	Y
interactionItem[].item.name	string	Type identifier for the item; expected value: `"MSISDN"`.	Y